MLE-23202 : Update package.json and changelog for 3.7.0 release. #945
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the package version from 3.6.0 to 3.7.0 and adds corresponding changelog entries for the new release. The changelog documents new functionality including base64 encoding/decoding methods for MarkLogic 12 and TLSv1.3 support, along with various security vulnerability fixes.
- Version bump from 3.6.0 to 3.7.0 in package.json
- Addition of 3.7.0 changelog section with new features and bug fixes
- Documentation of security vulnerability fixes with GitHub advisory links
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| package.json | Updates version number to 3.7.0 for new release |
| CHANGELOG.md | Adds 3.7.0 release notes with new functionality and security fixes |
Comments suppressed due to low confidence (1)
CHANGELOG.md
Outdated
| https://github.com/advisories/GHSA-fjxv-7rqg-78g4 | ||
| https://github.com/advisories/GHSA-8cj5-5rvv-wf4v | ||
| https://github.com/advisories/GHSA-c2qf-rxjj-qqgw | ||
| https://github.com/advisories/ghsa-3xgq-45jj-v275 |
There was a problem hiding this comment.
The GitHub advisory ID should be uppercase: 'GHSA-3xgq-45jj-v275' to match the format used in other advisory links in the changelog.
| https://github.com/advisories/ghsa-3xgq-45jj-v275 | |
| https://github.com/advisories/GHSA-3XGQ-45JJ-V275 |
There was a problem hiding this comment.
This is a good idea for consistency with the other GHSA URLs in this file.
CHANGELOG.md
Outdated
| ## 3.7.0 | ||
| #### New Functionality | ||
|
|
||
| - MarkLogic 12 users can now use the `base64Encode` and `base64Decode` methods compatible with server vector functions. |
There was a problem hiding this comment.
Identify the location of these functions (and use "function" instead of "method" as "function" is more appropriate for JS code) - /lib/vector-util.js - as there are also the vec encode functions which aren't what's being added here.
And technically, there's no dependency on the server here - these functions can be used regardless of the server version. I think the better way to describe it is (this also explains the "why" of why someone would care about these new functions):
"Can now encode and decode vectors through the base64Encode and base64Decode functions in the new lib/vector-util.js library. Encoding vectors before writing them to documents in MarkLogic 12 helps reduce the amount of disk space and memory consumed by vectors."
CHANGELOG.md
Outdated
| https://github.com/advisories/GHSA-fjxv-7rqg-78g4 | ||
| https://github.com/advisories/GHSA-8cj5-5rvv-wf4v | ||
| https://github.com/advisories/GHSA-c2qf-rxjj-qqgw | ||
| https://github.com/advisories/ghsa-3xgq-45jj-v275 |
There was a problem hiding this comment.
This is a good idea for consistency with the other GHSA URLs in this file.
CHANGELOG.md
Outdated
|
|
||
| - Can now encode and decode vectors through the `base64Encode` and `base64Decode` functions in the new lib/vector-util.js library. | ||
| Encoding vectors before writing them to documents in MarkLogic 12 helps reduce the amount of disk space and memory consumed by vectors. | ||
| - Support TLSv1.3 via Node Client. |
There was a problem hiding this comment.
Sorry I forgot to check the TLSv1.3 PR for this - we are exposing two new properties to users - minVersion and maxVersion. As the docs likely won't be updated soon, I think we need to provide more detail to the user here - i.e. that if they're using MarkLogic 12, the Node Client will default to TLSv1.3. And the user can also force min and max versions via those 2 new properties. Otherwise, the user will read this and not know what they need to do or can do to enable TLSv1.3.
2 participants
No description provided.